home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 1 / Cream of the Crop 1.iso / PROGRAM / PROTO212.ARJ / XSYS.REF < prev   
Text File  |  1992-01-24  |  2KB  |  97 lines
  1.  
  2.  
  3. 1        Introduction to xsys system                                       1
  4. 2        Putting xsys to work.                                             1
  5. 3        Performing transaction.                                           1
  6. 4        Controlling transaction.                                          2
  7.  
  8.  
  9. 1        Introduction to xsys system                                 
  10.  
  11.     Xsys is a dummy system to present the documentation tools 
  12.     provided in the Solucorp Programmer Toolkit. Please read 
  13.     document.exm before reading further. For now on, we are 
  14.     describing xsys as a real system.
  15.  
  16.     Xsys automated the processing of asynchronous transaction 
  17.     between two hosts.
  18.  
  19. 2        Putting xsys to work.                                       
  20.  
  21.     FUNCTION xsys_init:
  22.  
  23.     Initialise subsystem XSYS. This function is called once. bla 
  24.     bla bla.
  25.  
  26.     Return -1 if not successfull
  27.  
  28.     int xsys_init(
  29.         int memsize)    /* Amount of memory allocated to xsys */
  30.     
  31.  
  32.     FUNCTION xsys_end:
  33.  
  34.     Terminate use of subsystem XSYS.
  35.  
  36.     This function frees all buffers and completes any pending 
  37.     operation. After it has been called, xsys_init may be call 
  38.     again.
  39.  
  40.     void xsys_end(
  41.         void)
  42.  
  43. 3        Performing transaction.                                     
  44.  
  45.     FUNCTION xsys_transact:
  46.  
  47.     Perform one transaction interactivly.
  48.  
  49.     The function returns only when transaction is secure.
  50.  
  51.     int xsys_transact(
  52.         void)
  53.     
  54.  
  55.     FUNCTION xsys_batch:
  56.  
  57.     Perform one transaction without prompting the user. This 
  58.     function assumed a yes to each questions.
  59.  
  60.     The function returns immediatly without waiting for the 
  61.     background process to fully complete the transaction. See 
  62.     function xsys_flush().
  63.  
  64.     int xsys_batch(
  65.         void)
  66.     
  67.  
  68.  
  69.                                                               1
  70.  
  71.  
  72. 4        Controlling transaction.                                    
  73.  
  74.     FUNCTION xsys_undo:
  75.  
  76.     Undo the last transaction.
  77.  
  78.     This function must be called only in this and this and this 
  79.     situation.
  80.  
  81.     Return -1 if transaction can't be undone.
  82.  
  83.     int xsys_undo(
  84.         void)
  85.  
  86.     FUNCTION xsys_flush:
  87.  
  88.     Complete any pending transactions.
  89.  
  90.     This function must be called only in this and this and this 
  91.     situation.
  92.  
  93.     Return the number of transactions that has been completed.
  94.  
  95.     int xsys_flush(
  96.         void)
  97.